home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / stack26.zip / STACK.DOC < prev    next >
Text File  |  1990-08-31  |  24KB  |  581 lines
  1.      STACK - Command Line Editor/Enhancer, Version 2.4
  2.      =================================================
  3.  
  4. ACKNOWLEDGEMENTS
  5. ----------------
  6.  
  7. I thought that it was about time I gave credit to some of those 
  8. users whose suggestions have improved STACK or helped me isolate 
  9. faults.
  10.  
  11. Barry Foelsch of Raleigh, NC who helped me track down a problem 
  12. with mono displays.
  13.  
  14. All the members of the Canberra C SIG whose many suggestions 
  15. resulted in version 2.0
  16.  
  17. Jeff Bowles of Columbus, Ohio who helped isolate the repeated 
  18. command fault in version 2.3 and suggested the F3 option.
  19.  
  20.  
  21. AUTHOR'S RAMBLINGS
  22. ------------------
  23.  
  24. Isn't it always the way ?  You just finish setting up a new bit of
  25. software and out comes an upgrade.  However you shouldn't find
  26. updating to version 2.4 a traumatic experience as it is completely
  27. compatible with versions later than 2.0 and all of the new features
  28. are initially disabled.  Unfortunately I wasn't able to keep the
  29. command file to the same size as for 2.0 and it has grown by about 200
  30. bytes.  Still I think the size increase is worth the benefits.  (For
  31. those who are wondering what happened to 2.1 it had a minor bug which
  32. was quickly discovered but not until after I had distributed a few
  33. copies.)
  34.  
  35. The down side of all this is that STACK is now becoming fairly
  36. complex.  To combat this I have presented the commands available in
  37. two sections and new users may find it simpler just to use the basic
  38. commands initially and only use the more esoteric commands when they
  39. find they need them.
  40.  
  41. All of the new features have been included in the documentation and
  42. are summarized in the file HISTORY.STK
  43.  
  44.  
  45.  
  46.  
  47. WHAT IS IT ?
  48. ------------
  49.  
  50. There are a number of programs around that record the last few
  51. commands that were typed in a stack and allow you to recall them
  52. with a few key strokes.  I've always used one and feel a bit lost
  53. on a computer that doesn't have one.  The problem that I have
  54. with such utilities is that the stack quickly gets cluttered up
  55. with a 'rubbish' commands that I don't want to use again and I
  56. loose track of whether the command I want is still in the stack
  57. or has been pushed out.
  58.  
  59. STACK is my solution to this problem.  In addition to the usual
  60. command line editing features STACK allows you to flip open a
  61. window showing you what commands are in the stack.  You can also
  62. copy these commands to a separate list associated with the
  63. function keys.
  64.  
  65.  
  66. FOR USERS OF EARLIER VERSIONS
  67. -----------------------------
  68.  
  69. Users of version 1.x of STACK will notice a few changes,
  70. hopefully all for the better and none too traumatic.  The main
  71. changes are:
  72.  
  73. -  the command to modify STACK.COM is now ALT-W
  74.  
  75. -  the function key list now uses a select bar similar to the
  76.    command stack
  77.  
  78. -  the command stack is not cleared when STACK is loaded so it is
  79.    possible to save commands in the stack as well as the
  80.    function key list
  81.  
  82. -  new commands are always added to the bottom of the stack (as
  83.    displayed on the screen) with old commands dropping off the
  84.    top.
  85.  
  86. -  commands that are already in the command stack or function key
  87.    definitions will not be copied into the command stack.
  88.  
  89. There are some other minor differences but these can be changed
  90. with the setup utility.
  91.  
  92.  
  93. COMPATIBILITY WITH OTHER UTILITIES
  94. ----------------------------------
  95.  
  96. STACK patches some DOS interrupts and can clash with other
  97. resident utilities especially keyboard enhancers such as
  98. SMARTKEY.  If you load it before such utilities there shouldn't
  99. be any problem.
  100.  
  101. Some users have asked if it is possible to make STACK work within
  102. utilities such as XTREE that "shell" to DOS to let you execute
  103. commands.  The answer is a qualified sometimes.  Many of these
  104. programs don't actually shell to DOS but instead use their own
  105. code to collect a command string from you then get DOS to execute
  106. the command directly.  In these situations STACK doesn't get a
  107. look in and there is usually no way around it however setting the
  108. always enabled flag in STACK may work in some cases.
  109.  
  110.  
  111. COPYWRITE, ETC
  112. --------------
  113.  
  114. STACK (all versions) may not be sold for profit or "bundled" with
  115. other products without my permission.   Other than that there are
  116. no restrictions on who can use STACK or under what conditions.
  117. Go for it.
  118.  
  119.  
  120. COMMANDS - GENERAL
  121. ------------------
  122.  
  123. The commands recognized by STACK are presented in two groups, the
  124. common commands, which are essentially those compatible with
  125. earlier versions of stack, and the less common commands.  A
  126. summary of all commands is presented afterwards.
  127.  
  128. POSITION OF COMMAND LINE.  So that long command lines do not
  129. interfere with the window display STACK will automatically move
  130. the command line to the bottom of the screen if it might get in
  131. the road of an opening window.
  132.  
  133. TERMINOLOGY.  When a window is opened the highlighted line is
  134. referred to as the current command.  Except where otherwise
  135. indicated all commands affect or action the current command.
  136.  
  137. Where the command descriptions below refer to a command in the
  138. stack the details are equally applicable to function key
  139. definitions in the function key list, except where noted.
  140.  
  141.  
  142. COMMON (OLD) COMMANDS
  143. ---------------------
  144.  
  145. Return/Enter - execute the current command
  146.  
  147. UP       - select the preceding command and display it at the
  148. (arrow)    DOS prompt.  If a window is open the select bar is
  149.            moved to the previous command.  In 1.x versions of
  150.            STACK the up arrow recalled the command prior to the
  151.            last command rather than the last command.  Some users
  152.            found this useful and you can select between the two
  153.            alternatives using the setup utility.
  154.  
  155. F3       - using the setup utility F3 can be made to act the same 
  156.            the UP key.  If this option is selected then you can 
  157.            still invoke the F3 function from the function key 
  158.            list using the highlight.  To act as a reminder when 
  159.            F3 is switched to act as the UP key the 'F3' label is 
  160.            blanked out in the function key window.
  161.  
  162. DOWN     - select the next command and display it at the
  163. (arrow)    DOS prompt.  If a window is open the select bar is
  164.            moved to the next command.
  165.  
  166. PGUP     - open a window and display the command stack.
  167.  
  168. PGDN     - open a window and display the function key definitions
  169.            for the function key list.
  170.  
  171. HOME     - move the cursor to the left of the current command
  172.  
  173. END      - move the cursor to the right of the current command
  174.  
  175. DEL      - delete the character at the cursor
  176.  
  177. INS      - toggle insert mode.  Insert on is indicated by a block
  178.            shaped cursor.  The default insert state can be set
  179.            using the setup utility.
  180.  
  181. Backspace -delete the character to the left of the cursor
  182.  
  183. ESC      - clear the command line and close the window
  184.  
  185. TAB      - delete the currently highlighted command from the stack
  186.  
  187. Fn       - copy the command associated with that function key
  188. shift Fn   to the command line and execute it if the definition
  189.            is terminated with a carriage return (see next
  190.            command).  You can also issue the command associated
  191.            with a function key switching to the function key
  192.            window (PGDN) and selecting it with the highlight bar
  193.            and then pressing Return/Enter. The function keys that
  194.            can be programmed in this way are F1 to F10 and shift
  195.            F1 to shift F5.  See the note on F3 above.
  196.  
  197. Ctrl Fn  - copy the current command to this function key.  Ctrl F1
  198. Alt Fn     to ctrl F10 copy to the corresponding function key,
  199.            alt F1 to alt F5 copy to shift F1 to shift F5
  200.            respectively.  If STACK is currently in insert mode (ie.
  201.            you pressed INS and the block cursor is showing) then NO
  202.            carriage return is added to the end.  This means that you
  203.            can add some more to the end before pressing Return/Enter.
  204.            If insert mode if off then a carriage return is added to
  205.            the end and the command will be executed as soon